home *** CD-ROM | disk | FTP | other *** search
/ Ham Radio 2000 #1 / Ham Radio 2000.iso / ham2000 / packet / terminal / paket61 / tnc1.hlp < prev    next >
Encoding:
Text File  |  1994-08-15  |  17.2 KB  |  396 lines
  1. Command Reference for TNC1-Ver2  (TNC1.HLP Ver2.0)
  2. ═COMMAND══════ARG════DEFAULT═══════════DESCRIPTION═══
  3. *
  4. * Created 01JAN92 by N. J. McMillan (VK2XCI)
  5. * Parts of this file Copyright 1985, R.E. Raikes, (WA8DED).
  6. *
  7. * This file was created for use with the paKet (c) program only.
  8. *
  9. * The above two lines must remain in this file as is. They are used
  10. * by the program for the headings on the display window.
  11. * The first describes the type of TNC this file is set up for and
  12. * is displayed on the bottom of the TNC help window.
  13. * The second is the headings for the TNC help window and this line
  14. * should line up with the "header" data in this file.
  15. *
  16. * Each help item starts with its "header" which is identified by
  17. * the "@" in the first column. This is then followed by a variable
  18. * number of lines of detailed help for that item.
  19. *
  20. * Any line in this file beginning with an "*" is treated as a comment
  21. * and is ignored by the paKet program.
  22. *
  23. ******************************************************************************
  24. @A          0,1          1       Enable/disable Auto LINEFEED to terminal
  25. Parameters:
  26.       0 - Auto LINEFEED disabled.
  27.       1 - Auto LINEFEED enabled.
  28.  
  29. The 'A' command is used to control the insertion of a LINEFEED  after
  30. a CARRIGE RETURN  to the terminal. This parameter is stored in NOVRAM.
  31. ******************************************************************************
  32. @B          1-15         6       Select terminal baudrate.
  33. Parameters:
  34.      1 = 50               2 = 75              3 = 110
  35.      4 = 135              5 = 150             6 = 300
  36.      7 = 600              8 = 1200            9 = 1800
  37.      10 = 2400,          11 = 3600           12 = 4800
  38.      13 = 7200           14 = 9600           15 = 19200
  39.  
  40. This value is stored in NOVRAM. It must be 'PERMED'after being set and
  41. will then take effect following a 'RESET'. Rates above 4800 may not be
  42. reliable with sustained input (commands or information) from a host
  43. computer due to the slow CPU clock rate and non-vectored interupt
  44. architecture.
  45. ******************************************************************************
  46. @C          Cs1 [Cs2 - 9]        CONNECT path via optional repeaters.
  47. Parameters:
  48.       Cs1     = Destination callsign.
  49.       Cs2 - 9 = Optional repeater callsigns. (Up to 8 digipeaters)
  50. Examples;
  51.       C VK2XCI              CONNECT to VK2XCI direct
  52.       C VK2XCI VK2RGF       CONNECT to VK2XCI thru VK2RGF
  53.  
  54. The 'C' command is used to initiate a link connection. Note that NO 'v'
  55. or 'Via'is used between the destination callsign and the digipeater call-
  56. signs.
  57.  
  58. A 'C'command may be issued on a STREAM already in use to change the digi-
  59. peater callsigns, but not the destination callsign.
  60.  
  61. A 'C' command issued when STREAM 0 is selected sets the unproto path.
  62. Attempting to connect to more than one station on the same STREAM is not
  63. permitted.
  64. ******************************************************************************
  65. @D          none                 Initiate link DISCONNECT.
  66. Parameters:
  67.       None
  68.  
  69. The 'D' command is used to initiate a link disconnection. A 'D' command
  70. issued during the establishment or disestablishment of a link connection
  71. will immediately cause a return to the disconnected state.
  72.  
  73. A 'D' command issued on a disconnected STREAM will re-initialise the
  74. connection dependent parameters to the values stored in STREAM 0.
  75. ******************************************************************************
  76. @E          0,1                  Disable/enable input ECHO
  77. Parameters:
  78.       0 = ECHO disabled.
  79.       1 = ECHO enabled.
  80.  
  81.  
  82. The 'E' command is used to enable or dissable the echoing of input  to
  83. the terminal. This parmeter is stored in NOVRAM.
  84.  
  85. When using paKet you should set ECHO OFF.
  86.  
  87. paKet will display the characters you type in a different colour or
  88. intensity to help you distinguish your transmissions from the received
  89. data.
  90. *****************************************************************************
  91. @F          1 - 15       4       Frame acknowledge time (in seconds).
  92. Parameters:
  93.       'n' = 1 - 15  is the interval used to compute the time before an
  94.             unacknowledged packet is retransmitted.
  95.  
  96. The formula used is     time(secs) = F*{(2*number of digipeaters) + 1}
  97.  
  98. A separate fram ack. time is maintained for for each STREAM.
  99. The value stored in STREAM 0 is used to initialise each connection
  100. after a reset or disconnection. This value is stored in NOVRAM.
  101. ******************************************************************************
  102. @G          0,1                  Get information/link status (Host mode)
  103. Parameters:
  104.       0 = Get information.
  105.       1 = Get link status.
  106.  
  107. The 'G' command is used to interrorgate virtual TNC channels when HOST
  108. MODE is enabled.If no parameter is given the next chronological item
  109. (information or status) is returned. This command is invalid in terminal
  110. mode.
  111. ******************************************************************************
  112. @H          50 - 9600    1200    HDLC baud rate
  113. Parameters:
  114.       'n' = 50 - 9600. Non-standard values are rounded down to the next
  115.             possible baud rate.
  116.  
  117. Used with no parameter, 'H' displays the actual HDLC baud rate in use.
  118. HDLC baud rates of up to 9600 are supported if fast clock mode is enabled.
  119. This parameter is stored in NOVRAM.
  120. ******************************************************************************
  121. @I          callsign     blank   Sets the TNC source callsign
  122. parameters:
  123.       Callsign = Alpha-numeric string, being station callsign.
  124.  
  125.       Example   <esc> C VK2XCI
  126.  
  127. After the source callsign has been entered it should be PERMED for use
  128. during subsequent operation. Changing the source callsign while connected
  129. is not permitted.
  130. ******************************************************************************
  131. @JHOST      0,1          0       Enable terminal or host mode
  132. Parameters:
  133.      0 = Terminal mode
  134.      1 = Host mode
  135.  
  136. For paKet this MUST BE set to 0, terminal mode.
  137.  
  138. Host mode is intended to provide a user interface suitable for operation
  139. under the control of a host processor. This is fully discussed in the
  140. documentation:-    AX.25 Version 2
  141.                     Multi-channel
  142.                     TNC  FIRMWARE
  143.                    Copyright 1985, Ronald E. Raikes  (WA8DED)
  144. ******************************************************************************
  145. @K          1,2                  Calibrate TNC
  146. Parameters:
  147.       1 = Frequency counter.
  148.       2 = Tone levels and null.
  149.  
  150. The frequency counter mode will display the measured frequencies on the
  151. terminal. When each mode is selected, jumper settings and appropriate
  152. adjustment points are displayed. Values shown in parenthesis are the
  153. target values for 1200 baud operation.
  154. ******************************************************************************
  155. @L          0 - 4                Display link status.
  156. Parameters:
  157.       'n' selects STREAM to display.
  158.       If no parameter is given, all streams are displayed.
  159.  
  160. Information displayed includes the connection path, number of received
  161. frames not yet displayed, number of send frames not yet transmitted,
  162. number of transmitted frames not yet acknowledged and the current retry
  163. count.
  164.  
  165. A '+' character preceding the STREAM number indicates the currently
  166. selected STREAM.
  167. ******************************************************************************
  168. @M          NIUSCRT+-    UI      Set frame monitor mode.
  169. Parameters:
  170.       N = none
  171.       I = I (information) frames.
  172.       U = UI (un-numbered information) frames.
  173.       S = Supervisory frames.
  174.       C = Monitor While connected.
  175.       R = Monitor received (addressed to) frames.
  176.       T = Monitor transmitted (addressed from) frames.
  177.       + = Callsigns to be include (max of 8)
  178.       - = Callsigns to be excluded (max of 8).
  179.  
  180. The + and - parameters may not be used together. If either is used it
  181. must be the last parameter, followed by the callsign list.A + or -
  182. without a callsign will empty the list.
  183.  
  184. This parameter is stored in NOVRAM.
  185. ******************************************************************************
  186. @N          0 - 255      10      Set number of retries.
  187. Parameters:
  188.       'n' = Number of retries before a link failure is assumed.
  189.  
  190. This represents the number of times a frame will be transmitted without
  191. receiving an appropriate acknowledgement, before a link failure is
  192. assumed and a DISCONNECT issued.
  193.  
  194. A separate value for 'N' is maintained for each connected STREAM. The
  195. value stored in STREAM 0 is used to initialise each STREAM after a
  196. DISCONNECT or RESET.
  197.  
  198. This value is stored in NOVRAM.
  199. ******************************************************************************
  200. @O          1 - 7        4       Sets number of outstanding 'I' frames
  201. Parameters:
  202.       'n' = Max number of unacknowledged 'I' frames outstanding at
  203.             any one time.
  204.  
  205. A separate value for 'I' is maintained for each STREAM. The value stored
  206. in STREAM 0 is used to initialise each STREAM after a DISCONNECT or RESET.
  207.  
  208. This allows the TNC to send up to 7 FRAMES without waiting for an ACKNOW-
  209. LEDGE for each individual frame. When the ACKNOWLEDGE is sent, only those
  210. FRAMES which were missed are retransmitted.
  211.  
  212. With appropriate setting of 'F'(to allow the TNC to assemble and send the
  213. next FRAME), the transfer of long files over a good circuit is greatly
  214. expidited.
  215. ******************************************************************************
  216. @PERM                            Save current settings to NOVRAM.
  217. Parameters:
  218.       None. Immediate command.
  219.  
  220. This command writes the current settings to NOVRAM, (Non-Volitile RAM)
  221. overwritting the previous contents. These are then the new DEFAULT
  222. settings next time the TNC is powered up, or 'QRES' issued.
  223. ******************************************************************************
  224. @QRES                            Restart firmwear
  225. Parameters:
  226.       None. Immediate command
  227.  
  228. This is identical to a HARDWARE RESET. Entire RAM content is erased and
  229. the TNC restarted using the values stored in NOVRAM.
  230.  
  231. Note that any messages etc stored in RAM will be lost, the screen will be
  232. cleared, the sign on message will appear.and any connections lost.
  233. ******************************************************************************
  234. @R          0,1          0       Enable/disable DIGIPEATING.
  235. Parameters:
  236.       0 = DIGIPEATING disabled.
  237.       1 = DIGIPEATING enabled.
  238.  
  239. This parameter is stored in NOVRAM.
  240. ******************************************************************************
  241. @S          0 -4         1       Select the current STREAM number.
  242. Parameters:
  243.       'n' = STREAM on which communication will take place
  244.  
  245. This parameter is governed by the setting of 'Y', the number of STREAMS
  246. allowed.
  247.  
  248. If STREAM 0 is selected and a 'C' command issued, the UNPROTO path is set.
  249. This is the path which UI FRAMES are sent. eg CQ, BEACON etc. See also 'U'
  250.  
  251. Example:
  252.       <esc> S0    Sets TNC to STREAM 0
  253.       <esc> C [text] Cs1...Cs9  (where [text] is up to chars and Cs1...Cs9
  254.                                  DIGIPEATER path).
  255.       eg...<esc> C BEACON VK2RGF
  256.  
  257. The default path for STREAM 0 is CQ.
  258. ******************************************************************************
  259. @T          0 -127       30      Transmitter key-up delay. (10ms)
  260. Parameters:
  261.       'n' * 10 ms is delay between keying the transmitter and sending
  262.           a FRAME
  263.  
  264. This allows time for the transmitter to come up to power and settle on
  265. frequency befor a FRAME is sent. This allows for slow PLL-lock, relay
  266. switching and valve transmitters with inverter power supplies!
  267.  
  268. If problems are experienced with high FRAME REJECT rates, set this to 127
  269. and slowly reduce it to the lowest value allowing reliable communication.
  270. ******************************************************************************
  271. @U          0 - 2        0       Enable/disable Unattended/QST mode
  272. Parameters:
  273.       0  [text]            Unnattended mode disabled
  274.       1  [text]            Unnattended mode enabled
  275.       2  'n'  text         BEACON mode enabled. 'n' is the interval in
  276.                            in minutes from 1 to 65,535.
  277.  
  278. When UNNATTENDED mode is enabled, the TNC will send [text] in response
  279. to a connect. The connecting station may then leave a brief message,
  280. which will be stored in RAM. The message may be retrieved using the
  281. 'L' command.
  282. Example;
  283.       <esc>U1 Unnattended at the moment, please leave a brief message
  284.               and disconnect. Norm.
  285.  
  286. When BEACON mode is selected, the user supplied text will be sent at
  287. intervals set by 'n', to the UNPROTO  path set in STREAM 0. (See 'S'
  288. command).
  289. Example:
  290.       <esc>U2 15 Propagation test. Please QSL to VK2XCI. 73 de Norm.
  291.  
  292. This will result in the text "Propagation...Norm." being sent to the
  293. UNPROTO path every 15 minutes. Interval and text must be supplied
  294. each time BEACON mode is selected. Please use this mode sparingly as it
  295. may cause annoyance, or at worst degrade network performance.
  296.  
  297. Selecting UNNATTENDED or BEACON mode does not interfere with the
  298. ability CONNECT to another station in the usual manner on any STREAM.
  299. ******************************************************************************
  300. @V          1,2          2       Select protocol version.
  301. Parameters:
  302.       1 = Selects Version 1 protocol.
  303.       2 = Selects Version 2 protocol.
  304.  
  305. Leave this set to version 2. In any case the TNC will change to the
  306. version being used by the other station. A separate value is maintained
  307. for each STREAM, the value in STREAM 0 is stored in NOVRAM and is the
  308. value initialised to each STREAM following DISCONNECT or RESET.
  309. ******************************************************************************
  310. @W          0 -127       16      DIGIPEAT wait interval
  311. Parameters:
  312.       'n' = 10ms increments
  313.  
  314. This is the time interval that the TNC waits from receiving a packet,
  315. to retransmitting that same packet, when DIGIPEATING.
  316. ******************************************************************************
  317. @X          0,1          1       Enable/disable transmitter PTT.
  318. Parameters:
  319.       0 = Disable PTT.
  320.       1 = Enable PTT.
  321.  
  322. Command used in CALIBRATE routine etc to allow testing etc of TNC with-
  323. out causing network congestion/annoyance.
  324. ******************************************************************************
  325. @Y          0 - 4        1       Maximum number of STREAMS allowed
  326. Parameters:
  327.      'n' =  number of STREAMS to open.
  328.  
  329. This sets the maximum number of simultaneous connections which may be
  330. made. It should be set to the same value as set in the paKet config-
  331. uration file under "Max number of communications windows".
  332. ******************************************************************************
  333. @Z           0 - 3       3       Terminal flow control and handshaking.
  334. Parameters:
  335.       0 = flow disabled, XON/XOFF disabled.
  336.       1 = Flow enabled, XON/XOFF enabled.
  337.       2 = Flow disabled, XON/XOFF disabled.
  338.       3 = flow enabled, XON/XOFF disabled.
  339.  
  340. If flow control is enabled, output to the terminal will be inhibited
  341. while entering commands or information. If XON/XOFF handshaking is
  342. enabled, CRT scrolling may be stopped using <CONTROL-S> and started
  343. with <CONTROL-Q>.
  344.  
  345. Flow control and handshaking should be disabled (0) while the TNC is
  346. operated without a terminal, to avoid consuming buffers in the TNC.
  347.  
  348. Refer to the section on Hardware vs Software Handshaking in the paKet
  349. manual.  If you are using a full RS-232 cable, you should disable flow and
  350. specify HW handshaking in paKet.
  351.  
  352. This parameter is stored in NOVRAM.
  353. ******************************************************************************
  354. @@B                              Display number of free buffers.
  355. Parameters:
  356.      'n' = Number of free buffers. available.
  357.  
  358. Software Maintainence command.
  359. ******************************************************************************
  360. @@C         0,1          0       Enable/disable fast CPU clock.
  361. Parameters:
  362.      0 = Fast clock disabled.
  363.      1 = Fast clock enabled.
  364.  
  365. Software maintenance command.
  366. ******************************************************************************
  367. @@P         0 - FF       0F      Protocol ID.
  368. Parameters:
  369.       none.
  370.  
  371. This Value should not be altered. It identifies the protocol in use on
  372. each STREAM.
  373. ******************************************************************************
  374. @@S                              Display currnt link state.
  375. Parameters:
  376.       none.
  377.  
  378. Software maintenance command.
  379. ******************************************************************************
  380. @@T2        0 -255       100     Software timer #2 period.
  381. Parameters:
  382.       'n' = period in 10ms increments
  383.  
  384. This sets the period from when the TNC receives an INFORMATION FRAME, to
  385. when it issues the RESPONSE FRAME. This delay allows multiple FRAMES to
  386. be ACKNOWLEDGED with a single response.
  387. ******************************************************************************
  388. @@T3        0 -32767     18000   Software timer #3 period.
  389. Parameters.
  390.       'n' = period in 10ms increments.
  391.  
  392. Timer T3 is used to maintain link integrity. If there is no activity
  393. during the T3 period, the TNC will poll the distant station to verify
  394. that it is still connected.
  395. ******************************************************************************
  396.